home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / bbs / isbull.zip / ISBULL.DOC next >
Text File  |  1993-01-04  |  21KB  |  425 lines
  1.  ┌──────────────────────────────────────────────────────────────────────────┐
  2.  │                     Is That a Bulletin Manager?                          │
  3.  │   A News/Bulletin Management System for TBBS 2.2 and TDBS 1.2.4          │
  4.  │                                                                          │
  5.  │          By Christopher Blaise, January 1993 - Version v1.3              │
  6.  │                      This program is Shareware                           │
  7.  └──────────────────────────────────────────────────────────────────────────┘
  8.  
  9.  (Note: Paragraphs denoted by an asterick (*) detail either a documentation
  10.   change from v1.2 or 1.3 feature)
  11.  
  12.         Don't you just hate taking the type to write and format your
  13.  SIGNON2.TXT news file to inform them that the system hasn't been receiving
  14.  echomail for 3 days now, THEN get a message from a user asking "Where's the
  15.  new echomail?"
  16.  
  17.         Or isn't it a pain to maintain a bulletin area?  You either have
  18.  to create a menu to store them all, or use the TBBS Type 3 command, or
  19.  something like that.  Any way, it's hard to remember filenames to update
  20.  them or add new/delete old entries.
  21.  
  22.         Or your D&D Sysop needs a place for his/her bulletins.  Same problem
  23.  as above, but you have to spend more time listening to the SigOp, making
  24.  the changes they need for a successful campaign ("No, no, the entry title
  25.  should be "Ghosts & Goblins, not GOATS & Goblins!").
  26.  
  27.         Or perhaps you want to attach a file to the bulletin.  Wouldn't it
  28.  be nice to give the user the option of downloading it after they've read
  29.  the bulletin?  Or what about downloading the bulletin itself?
  30.  
  31.         Whatever your bulletin problem is, here's a solution: Is That
  32.  a Bulletin Manager?  It functions as a SIGNON2.TXT replacement program
  33.  and a general purpose bulletin manager.  You can also configure it so that
  34.  your SigOps can only edit their bulletin files.
  35.  
  36. ┌────────────┐
  37. │HOW IT WORKS│
  38. └────────────┘
  39.  
  40.         As a regular bulletin program, it works as an easy organizer
  41.  to show your bulletins, and to let your users know which ones
  42.  they've read.  As a logon bulletin program, it allows you to force
  43.  users to read your logon bulletins.  In the logon bulletin setting you
  44.  may define the how many times a user "skips" bulletins, or chooses to not
  45.  read new bulletins.  If their maximium skips for any bulletin is reached,
  46.  they are forced to read that bulletin or bulletins.  If they have already
  47.  read the bulletin, the skip value is ignored.  For example, you set the
  48.  system skip rate to 3 times.  The user reads the bulletin on his first
  49.  or second logon.  On the third time, they will not have to read the bulletin
  50.  because they have read it already.  Additionally, if they have
  51.  read all bulletins in the logon setting, the program will simply quit
  52.  without even prompting them to read already-read bulletins.
  53.  
  54.  Here's the display format:
  55.  
  56.  <title>
  57.  ───────────────────────────────────────────────────────────────────────────
  58.  Bulletins You Have Already Read Have A Slash (/) Before Them
  59.                                                ^
  60.                                                \--Will be a √ if in ANSI mode
  61.  / <A>  <headline 1>                                               (<date 1>)
  62.    <B>  <headline 2>                                               (<date 2>)
  63.  ───────────────────────────────────────────────────────────────────────────
  64.  You Must Read All Bulletins!
  65.  Read Which Bulletin (A-B or <Enter/Return> to Quit):
  66.  
  67.  An Example would look like:
  68.  
  69.  Wintermute Bulletins
  70.  ───────────────────────────────────────────────────────────────────────────
  71.  Bulletins You Have Already Read Have A Slash (√) Before Them
  72.    <A>  New Menu Changes!  Important!                             (01/12/92)
  73.  √ <B>  Have You Changed Your Password Lately?                    (01/12/92)
  74.  ───────────────────────────────────────────────────────────────────────────
  75.  You Must Read All Bulletins!
  76.  Read Which Bulletin (A-B or <Enter/Return> to Quit):
  77.  
  78.         As if you couldn't tell from the key entries, there is a limit
  79.  of 26 bulletins in any given database (A-Z).
  80.  
  81. *       When I originally wrote the program, I wanted to provide the
  82.  "look-feel" to my users that would be framiliar as the rest of the TBBS
  83.  system.  For that reason, from it's beginning, I have concentrated EXCLUSIVELY
  84.  on the bulletins being TEXT FILES displayed with the TBBS TYPE 1 command
  85.  just for those two simple <P>ause and <S>top functions.
  86.  
  87. *       The reason for that little background is to stress that while this
  88.  program supports the use of memo fields, THEY ARE NOT RECOMMENDED for the
  89.  simple reason that they are fairly difficult to manipulate and thus
  90.  the above TBBS TYPE 1 command "feel" can not be (reasonably) implemented
  91.  using them.  Their support stems from the need to use the memo field
  92.  full screen editor to read and write the text bulletins online.  I added
  93.  the support primarily because it was fairly easy to do so, but there are
  94.  absolutely no frills included.  They can be used as a "troubleshooting"
  95.  method - if the text bulletin file doesn't exist, the memo will be displayed
  96.  as the bulletin.  In short - You can use them.  They work without what I
  97.  consider the "proper" pausing and stopping routines.  I don't recommend
  98.  using them.
  99.  
  100. ┌───────────────────────────────────┐
  101. │INSTALLING - THE MAINTENANCE MODULE│
  102. └───────────────────────────────────┘
  103.  
  104.         The first entry you'll want is the maintenance module.  To
  105.  activate it, create a TBBS menu entry like:
  106.  
  107.         Entry:
  108.         [B]  Is That a Bulletin Manager?
  109.         KEY=B TYPE=200 OPT DATA=ISBULL.TPG/Q &M
  110.  
  111.  NOTE THE PLACEMENT OF THE /Q!  It must be added directly after the
  112.  .TPG name, if the switch is used.  Also be aware that the Maintenance Module
  113.  works with ANSI only.
  114.  
  115.         You can also have the maintenance portion use a single database
  116.  for delegation to SIGOPS, such as:
  117.  
  118.         Entry:
  119.         [D]  D&D Bulletins Maintenance
  120.         KEY=D TYPE=200 OPT DATA=ISBULL.TPG/Q &M.DND
  121.  
  122.         If the database does not exist, then it will automaticly be created!
  123.  
  124.         Additionally, there is an option for allowing the SigOp to edit the
  125.  Configuration section or not.  This accomplished with the "P=xxx" directive
  126.  to determine the lowest possible privelege level to edit with in the
  127.  OPT DATA field such as:
  128.  
  129.         Entry:
  130.         [D]  D&D Bulletins Maintenance
  131.         KEY=D TYPE=200 OPT DATA=ISBULL.TPG/Q &M.DND P=255
  132.  
  133.         While using as a logon bulletin replacement that only you as the
  134.  SysOp will be editing, it probably won't be of much value, it probably
  135.  will to the SigOp who may decide to change the default path to
  136.  C:\TBBS!  This option also prevents the SigOp from adding their own path
  137.  in the Bulletin Text field (see below).  Anyone with a privelege over
  138.  this level can though.
  139.  
  140. ┌──────────────────────────────┐
  141. │RUNNING THE MAINTENANCE MODULE│
  142. └──────────────────────────────┘
  143.  
  144.         When you first enter the maintenance module, you will be prompted
  145.  for a filename.  This is a 1-8 character DOS filename with NO extention.
  146.  If you enter nothing, the program quits.  If you enter a filename,
  147.  ISBULL will notify you whether the file exists or not and if it doesn't,
  148.  if you wish to create it.  If you say "Yes", then the following files will
  149.  be created:
  150.  
  151.         ????????.BUL - Bulletin Information
  152.         ????????.CFG - Bulletin Configuration
  153.         ????????.USR - User Records
  154.         ????????.NDX - Index of the User Records
  155.         ????????.CLR - Color Information
  156. *       ????????.LNG - Text Information.  This file will automaticly be
  157.                        created if you're upgrading from ISBULL 1.2.
  158.  
  159.         You will now be in the configuration menu.  The screen should be
  160.  pretty self explanitory, but here's a short description of each field:
  161.  
  162.         Bulletin Information:
  163.         Bulletin # - The number of the bulletin
  164.         Date - Date that bulletin was last updated.  You do have the option
  165.                to change this to a different date.
  166.         Headline - Title of the bulletin that the user will see on the
  167.                    bulletin screen.
  168.         Bulletin Text - <d:><path>filename.txt.  Actual text of bulletin
  169.                         in a text file.  If the path is not given, then
  170.                         the Path (defined below) is added onto the
  171.                         beginning of the filename.
  172. *       Attach This Text - Should the user be allowed to download this text
  173.                            file?  THIS WILL NOT WORK IF YOU'RE USING THE
  174.                            MEMO FIELD OPTION.
  175. *       Attached File - <d:><path>filename.txt.  File to download as a
  176.                         file attach.  This could be any downloadable
  177.                         file.
  178.         Configuration Information:
  179.         Path - The default path where your bulletins will be located.
  180. *       Country - The format that the date should be displayed in:
  181.                   1 - USA
  182.                   2 - European
  183.                   3 - Japanese
  184.         Skips - Amount of times, in a Logon-type setting that a user may
  185.                 skip the reading of any/all bulletins.  A 0 means that
  186.                 they cannot procede without reading all of the bulletins
  187.                 (or new bulletins)
  188.         Use Editor - Should you allow the use of the TDBS memo editor as
  189.                      a method of editing either the memo field or the
  190.                      text file via the ^R(ead) and ^W(rite) commands?
  191. *       Protect Read Path - Do you want to limit yourself or your sigops to
  192.                             reading files ONLY in the HOMEPATH (the directory
  193.                             that you ran ISBULL from)?
  194. *       Protect Write Path - Do you want to limit yourself or your sigops to
  195.                              writing files ONLY to the HOMEPATH (the directory
  196.                              that you ran ISBULL from)?
  197.         Note: There IS a difference between the Default Path and the HOMEPATH.
  198.               The Default Path can be any path on your system.  The HOMEPATH
  199.               is SPECIFICLY defined by TDBS to be the directory that you
  200.               are running ISBULL from in your OPT DATA field.  If your OPT DATA
  201.               field is C:\TDBS\ISBULL and your Default Path is defined as
  202.               C:\TDBS\ISBULL\SIGNON, the abovementioned Protects will only
  203.               allow read/writing to/from C:\TDBS\ISBULL.
  204.  
  205.         The Menu should also be clear, but here are the details:
  206.  
  207.         <Left/Right Arrows> - Go to the previous or next record.
  208.         <Up/Down Arrows> - Edit the Bulletin Information section.  Allows
  209.                            you to change the Headline, Date, and Text fields.
  210.         <A> Add a Record - Add a New record with blank fields.
  211.         <D> Delete Current Record - Mark/Unmark this record for deletion.
  212.             Any records marked for deletion will be purged from the database
  213.             upon quitting the maintenance module.
  214. *       <U> Upload/Edit Bulletin - Upload the text for this current bulletin
  215.             or edit it via the TDBS memo editor.  Uploading uses the TBBS TYPE
  216.             30 command and forces the filename from the Bulletin Text field.
  217.             Editing uses the TDBS memo editor to edit either the memo field or
  218.             read/write the text file.
  219.         <C> Clear User's Read Flags - In actuality, it will delete the
  220.             ????????.USR and ????????.NDX files and re-create them.
  221.         <F> Edit a User's Flags - This will create another area below
  222.             Configuration Information section.  You will be asked for
  223.             the user's name.  If it is not found, the area will clear.
  224.             If found, that user's bulletin and skip settings will be
  225.             displayed and you will be able to edit them.
  226.         <I> Edit the configuration Information - Edit the Title, Skips & Path
  227.             fields.
  228. *       <O> Change Colors.  Modify any color in the bulletin or configuration
  229.             module.  Both SysOps and SigOps can change these colors.
  230.             This module should be pretty much self explanitory, but here's how
  231.             the color choosing works:
  232.  
  233.        ╔══════════════════════════════════════════════════════════════════╗
  234.        ║1║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  235.        ║2║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  236.        ║3║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  237.        ║4║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  238.        ║5║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  239.        ║6║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  240.        ║7║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  241.        ║8║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  242.        ║9║ 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132║
  243.        ╚══════════════════════════════════════════════════════════════════╝
  244.         ^ \ _____________________________/\ _____________________________/
  245.         |  ^                               ^
  246.         |  \ Foreground Colors (Normal)    \ Foreground Colors (Blinking)
  247.         |
  248.         \ Background Colors
  249.  
  250. *       <L> Edit Text - Edit any text string for the bulletin module.
  251.             (see section on editing these strings below)
  252.         <Q> Quit & Clean Up - This will purge any deleted files from the
  253.             ????????.BUL file and update pointers for newly added bulletins.
  254.  
  255. ┌───────────────────────┐
  256. │LANGUAGE CONSIDERATIONS│
  257. └───────────────────────┘
  258.  
  259.         All text should be self-explanitory.  There are, however, two main
  260.  items to keep in mind when editing the language files.
  261.  
  262.         The first is the parameters.  There are only two places these
  263.  are used - the Notify and "Which Bulletin..." texts.  Like the parameters
  264.  in EDLANG, they are in the %n format.  Since each of these only use one,
  265.  they are %1 and %1 in each string.  In Notify, it's the placement of
  266.  the "checkmark" and in "Which bulletin...", it's where the alphabetic
  267.  bulletin range is placed (ie. A-B, A-F, etc.).  IT IS IMPORTANT THAT YOU
  268.  CORRECTLY KEEP/PLACE THESE PARAMETERS IN THE STRINGS.  DON'T LEAVE THEM
  269.  OUT.
  270.  
  271.         The other is the use of brackets.  The quick rule of thumb is this:
  272.  the default bracket set is '<' and '>'.  ANYWHERE else in the language file
  273.  where these initially show up this is what they will be and you CANNOT use
  274.  these brackets for any other purpose.  For example, on the "Which bulletin..."
  275.  string:
  276.  
  277.          Read Which Bulletin (%1 or <Enter/Return> to Quit)
  278.  
  279.  There are two sets of brackets you may wish to use, either the '<', '>' set
  280.  or '(',')' (or any variations thereof).  If you wish to change to the
  281.  '(', ')' method, you must change the string to accurately reflect this:
  282.  
  283.          Read Which Bulletin <%1 or (Enter/Return) to Quit>
  284.                              ^                            ^
  285.                              \────────────────────────────/
  286.  
  287.  Where the two brackets pointed to can really be anything BUT the '(' and ')'
  288.  characters.  The reason is that anything in the language defined "bracket"
  289.  characters tells ISBULL to put them into the Keys (see the Colors screen)
  290.  color.  Also remember to change the brackets for the other strings
  291.  such as the File Attach and Bulletin Download strings.
  292.  
  293.         If you don't follow the above instructions, at worst you're going to
  294.  have a very messy looking program.  If you've tried to work with it and
  295.  have really messed the whole thing up, simply delete the ????????.LNG file
  296.  as ISBULL will automaticly create it to it's original state.
  297.  
  298.         As you will notice, you are only able to edit the bulletin module text
  299.  - there is no support for editing the configuration text.  The reasons for
  300.  this are a) I see it more important for you to alter the portion of the
  301.  program that is going to affect how your system looks b) Much of the
  302.  configuration module is based on how things are placed in that limited
  303.  80x24 dimensions - there isn't any easy room for custom "configuration text".
  304.  As you've noticed, however, I did think it was realitively simple to allow
  305.  you to change the configuration colors.
  306.  
  307. ┌───────────────────────────────┐
  308. │INSTALLING THE USER-END-MODULES│
  309. └───────────────────────────────┘
  310.  
  311.         To install as a logon-type bulletin manager, use the following
  312.  format:
  313.  
  314.         Entry:
  315.         KEY=^@ TYPE=200 OPT DATA=ISBULL.TPG/Q &L.<bulletin name>
  316.  
  317.  My technique:  I use 2 main menus.  MENU0000.CTL is more of a "switch-board"
  318.  menu for tossing people into respective areas based on their access
  319.  (ie. New users goto the new user menu, regulars go to the top menu).
  320.  Here is an SDL example of how I handle this, so that everytime users goto
  321.  the main menu, they won't get the program:
  322.  
  323.         MENU:0000
  324.         Entry:
  325.         KEY=^@ TYPE=200 OPT DATA=ISBULL.TPG/Q &L.signon
  326.  
  327.         ENTRY:
  328.         KEY=^@ TYPE=35 OPT DATA=TOP
  329.         ENDMENU:
  330.  
  331.  As you see, this example uses the nifty new TBBS 2.2 type 35 command to
  332.  make MENUTOP.CTL the top menu for the duration of the call.
  333.  
  334.  
  335.         To install as a regular bulletin manager is easier.  Just make
  336.  an entry in the following format:
  337.  
  338.         Entry:
  339.         KEY=^@ TYPE=200 OPT DATA=ISBULL.TPG/Q &B.<bulletin name>
  340.  
  341.  Practical useage could look like:
  342.  
  343.         Entry:
  344.         [B]  General Bulletins
  345.         KEY=B TYPE=200 OPT DATA=ISBULL.TPG/Q &B.bulls
  346.  
  347.         Entry:
  348.         [N]  Re-Read Logon Bulletins
  349.         KEY=B TYPE=200 OPT DATA=ISBULL.TPG/Q &B.signon
  350.  
  351.  NOTE:  If you use the logon bulletin in this way, that is, as a logon
  352.  bulletin AND a regular bulletin, the reader will not have to read
  353.  the bulletin at logon if they have read it in the above section.
  354.  
  355. ┌────────────────────────┐
  356. │DISCLAIMER/CODE OF HONOR│
  357. └────────────────────────┘
  358.  
  359.         As ever a software author, here it is:
  360.  
  361.  DISCLAIMER: I, Christopher Blaise will take NO responsibility for any
  362.              losses, mistakes, or otherwise errors you may incur from using
  363.              this program.
  364.  
  365.         As a TDBS author:
  366.  I DID NOT program any 'hooks' or 'barbs' into this software that would
  367.         intentionally compromise the integrity of your system (or mine!)
  368.  I HAVE TRIED to make sure that this piece of software is not only
  369.         bullet-proof, but also easy for you the Sysop to setup and maintain,
  370.         and for your users to use.
  371.  I WILL TRY to fix any problems or errors brought to my attention.  Feature
  372.         requests are *always* welcome and listened to, but it doesn't
  373.         necessarily mean I'll implement them.
  374.  
  375. ┌────────────┐
  376. │REGISTRATION│
  377. └────────────┘
  378.  
  379.         If you like this program, please register it.  The cost is $10.
  380.  That's right...no missing '0's.  Ten bucks.  The price of a relatively
  381.  inexpensive dinner, or a box of diskettes.  Part of my rational for this price
  382.  is based on the features which are powerful yet help you make this program
  383.  suitable for retaining your system's unique look and feel.  I honestly think
  384.  it's a well written piece of work.  The other part of my program price
  385.  basis is simple - would I pay this much for this program as a consumer?
  386.  I would - I think this is great deal, and hope you do too!  Please send your
  387.  check for $10 to:
  388.  
  389.          US Snail:      Christopher Blaise
  390.                         RR 1 Box 2540
  391.                         Hinesburg,VT 05461
  392.  
  393.         Please be sure to add either an address, or perferably a Fidonet or
  394.  Internet address.  All registered users will be notified by either electronic
  395.  mail or U.S. snail mail for a place to pick up the latest version, either by
  396.  FREQ or calling the BBS.  The location will either be Wintermute.
  397.  
  398. ┌─────────────┐
  399. │CONTACTING ME│
  400. └─────────────┘
  401.  
  402.         If you'd like to drop me a line with errors, problems, or just
  403.  to let me know what you think of this program in general, I'd love to hear
  404.  from ya!  In addition to the above address, I can be reached at:
  405.  
  406.          Fidonet:  CHRISTOPHER BLAISE on 1:325/110 Wintermute HUB
  407.          Internet: Christopher.Blaise@moose.uvm.edu
  408.  
  409. ┌─────────────────────────┐
  410. │OTHER NICE PIECES OF WORK│
  411. └─────────────────────────┘
  412.  
  413.  I also have some other programs if you're interested:
  414.  ISPROB.TPG - .DBF "prober".  Allows you to look around, edit, make
  415.               indexes, etc. on an existing dBASE III+ type .DBF file.
  416.  LOCATE.TPG - Location Changing program for users.  Cheap n' easy
  417.               programming job but the users *love* it!
  418.  
  419. ┌────┐
  420. │BYE!│
  421. └────┘
  422.  See ya!
  423.  TTYL
  424.  Chris
  425.